<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/shm/classic/server_session.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_23fbec4e7c966aae2efbb90aeb47f596.html">session</a></li><li class="navelem"><a class="el" href="dir_49621dcf2e58f6d541462f9bec53bd7e.html">shm</a></li><li class="navelem"><a class="el" href="dir_aa9b1de9a811fc0081d5a436dbc37c19.html">classic</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">server_session.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Shared Memory</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="session_2shm_2classic_2classic_8hpp.html">ipc/session/shm/classic/classic.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="shm_2classic_2classic_8hpp.html">ipc/shm/classic/classic.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__shm_2src_2ipc_2session_2detail_2shm_2classic_2server__session__impl_8hpp.html">ipc/session/detail/shm/classic/server_session_impl.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__shm_2src_2ipc_2session_2shm_2classic_2session_8hpp.html">ipc/session/shm/classic/session.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2server__session_8hpp.html">ipc/session/server_session.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;boost/move/make_unique.hpp&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session_1_1shm_1_1classic.html">ipc::session::shm::classic</a></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>{</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * Identical to session::Server_session in every way, except that it makes available two SHM arenas, from the</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * SHM-classic provider (ipc::shm::classic::Pool_arena), symmetrically accessible by the opposing side. These</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * SHM arenas (see #Arena doc header) have different scopes:</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> *   - Per-session-scope, accessible via session_shm(): meaning it shall be accessible only during the lifetime of</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> *     this session, by this Session (via this accessor) and the opposing Session (via its counterpart thereof).</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *     - Hence this arena is created at the time both mutually opposing Session objects, including `*this`,</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *       enter PEER state (more precisely just before the shm::classic::Client_session receives word from</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *       `*this` that log-in is successful).  When `*this` is destroyed or hosed, the arena is invalidated.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *   - Per-app-scope, meaning its pool shall be accessible potentially beyond the lifetime of</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *     this session but rather until the generating Session_server (i.e., server process) shuts down, by any</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *     Session under that umbrella, now or in the future, as long as its Client_app equals that of `*this` session.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *     - Hence this arena is created at the time the shm::classic::Session_server (emitter of `*this` to user) first</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *       establishes a session with the *first* shm::classic::Client_session matching the same Client_app as `*this`.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *       I.e., it&#39;s created at the same time as `this-&gt;session_shm()` is, if `*this` is the first such session;</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *       otherwise earlier.  When `*this` is destroyed or hosed (gracefully at least), the arena is *not*</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *       invalidated but persists.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * ### Explicitly constructing an object in SHM; lending to opposing side ###</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * This setup is symmetrical w/r/t a given shm::classic::Server_session&lt;-&gt;shm::classic::Client_session object pair.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * Both can create new objects (via respective `Arena::construct()` methods).  Both can write and, of course, read.</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * Lastly each can transmit any outer handle, returned by `construct()`, to the opposing side.  To do this,</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * call lend_object(), transmit the returned `Blob` to the opposing side via any desired IPC form (probably a</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * transport::Channel or transport::struc::Channel), then recover a handle via borrow_object() on that</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * opposing side.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * By using `shm::stl::Arena_activator&lt;Arena&gt;` (alias shm::classic::Pool_arena_activator) and</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * #Allocator (alias shm::classic::Pool_arena_allocator) it is possible to construct and transmit not just POD (Plain</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * Old Datatype) objects but combinations of those with unlimited nested levels of STL-compliant containers.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * On the borrowing side use #Borrower_allocator for maximum SHM-provider-independence of your code.  (But see</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * the following note: your algorithm may require features not available in the alternative, SHM-jemalloc,</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * in which case... well, read the note.)</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * @note For SHM-classic, #Borrower_allocator *is* #Allocator.  If the borrowing side means to make changes to</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> *       the data itself, it (stylistically speaking) can simply use #Allocator (and `Arena_activator&lt;Arena&gt;` again).</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> *       However, if the borrowing side maintains read-only access throughout, then by using #Borrower_allocator</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *       the code will remain SHM-provider-agnostic and continue working if the ipc::session sub-namespace</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *       is changed back and forth betweeen `classic` and `arena_lend::jemalloc`.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * Detailed instructions can be found in those shm::stl and ipc::shm::arena_lend doc headers.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * ### Using SHM as backing memory for transport::struc::Channel ###</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * Another use of session_shm() and app_shm() -- in some ways perhaps superior -- is indirect.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * The above technique involves manually constructing a C++ data structure and transmitting a short handle</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * to it over IPC thus achieving high performance.  It may be desirable, instead, to use a structured message,</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * filled out according to schema.  This, of course, is why transport::struc::Channel exists.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * As is explained in its docs, there is nothing SHM-centered about it.  It does however have the key feature</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * that allows one to supply, at compile-time, the builder and reader engines that acquire memory</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * while the user mutates an out-message and later accesses it upon IPC-receipt.  Naturally one of the</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * builder/reader pairs uses SHM, instead of regular heap, as the supplier of RAM.  Thus when</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * one invokes transport::struc::Channel::send() and receives it in the opposing object, the actual bits</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * copied into/out of the low-level transport are merely the SHM handle (and all of this is hidden from the user</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * outside of the delightful near-zero-copy perf properties).</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> *</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * There are two ways to make this happen.  The easiest and best way is, when constructing the</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * `struc::Channel`, to use the tag-form ctor with tag</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * transport::struc::Channel_base::Serialize_via_shm_classic.  Simply provide that tag,</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * `this` (or, symmetrically, `shm::classic::Client_session::this` on the other side), and specify which of the</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * 2 scopes you desire (per-session or per-app: a `bool`).</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * The harder way, albeit allowing for certain advanced setups, is to manually create a</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * `transport::struc::shm::classic::Builder::Config` and/or `Reader::Config`,</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * passing in `this-&gt;session_shm()` and/or `this-&gt;app_shm()`, to those;</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * and then pass the `Config` or `Config`s to the non-tag-form of `struc::Channel`</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * ctor.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * This is all documented on transport::struc::Channel.  Do realize, though, that those niceties are</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * really built on this class template and/or the opposing shm::classic::Client_session.  To use them with</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * ipc::session, you must thus choose shm::classic::Server_session and shm::classic::Client_session as your</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * Session impls.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * ### Implementation ###</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * It is probably not too difficult to understand how it works by just reading the code and doc headers.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * The key is that the core is still just what&#39;s supplied by a vanilla (non-SHM-aware) #Server_session.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * Ultimately all we need to add is a bit of setup near the end of the vanilla session-opening procedure.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * This is easiest to discuss holistically, meaning both the server (`*this`) and client (opposing) side,</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * so the discussion is all here.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * As with the vanilla session setup, remember that while in PEER state the APIs are identical/symmetrical,</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * the roles of the server and client vary quite sharply internally -- especially before PEER state.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * The general outline is: Session_server listens for socket connections; a given</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * `Client_session_impl::async_connect()` connects; at this stage Session_server constructs a not-yet-user-emitted</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * #Server_session and invokes its `async_accept_log_in()`.  Now the #Client_session and #Server_session</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * have established a channel (internal-use session master channel) and undergo the log-in exchange.</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> * #Client_session sends log-in request.  #Server_session verifies that, then replies with log-in response</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * (including important bits of generated naming) and enters PEER state.  Once #Client_session (shortly) receives</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * this response, it knows the session is ready to rock and also enters PEER state.  Voila.</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * Where does SHM-classic setup hook into this?  Fairly naturally: The server side is in charge of</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * setting up shared resources -- any required SHM arena(s) -- and once they exist, and only then,</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * can it send log-in response.  The client side *then* opens them, since by then they&#39;re guaranteed to exist.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * In the case of these SHM-classic `Pool_arena`s, the way that part works is simple: the server side names</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> * each pool according to a certain convention, so the client (knowing that the timing is right) opens</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> * each pool according to the same convention (and the information received in the log-in response is part of</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * that).</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * Thus:</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> *   - The additional (SHM-classic-related steps) take place during log-in over session master channel, no earlier.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *   - The server, first (before log-in response but *after* it knows everything else about the budding session --</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *     so in fact *right* before sending log-in response), ensures the 2 SHM arenas (per-session and per-app) required</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> *     to be shared have been created.   Then it sends the log-in response like usual.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> *   - The client, like usual, awaits log-in response; and once that arrives it completes the normal vanilla</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *     entry to PEER state.  However the additional step it needs is to open the 2 SHM arenas guaranteed to</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *     exist, since log-in succeeded.  Once it has done that, we&#39;re done.</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> *</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> * Now to discuss the specifics of each SHM scope.  The simpler one is per-session (session_shm()).</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> * It is, naturally, created once for each session; so it has to be just before Server_session_impl</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> * `send()`s the log-in response.  The naming is by the standard convention (see util::Shared_name doc header;</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> * see build_conventional_shared_name() which applies the convention).  `Pool_arena` constructed in</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> * `CREATE_ONLY` mode (1) creates underlying named pool; and (2) retains an open handle to it.</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> * So we just do that which gives us the thing to return in session_shm() from then on.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> * Slightly trickier is per-app (app_shm()).  It is actually similar in terms of timing: it&#39;s done just then</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> * as well, because why not?  However, for a given distinct Client_app, pool has to be *created* only the first time</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * Session_server encounters an instance of the application described by that Client_app; after that it&#39;s already</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * created, so no creation is necessary.  Either way, keep the handle around to return in app_shm().</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> * However, by definition, a given per-app arena is to stay alive until the entire server (shm::classic::Session_server)</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> * is destroyed; resources (including transport::struc::Msg_out) residing in an app_shm()-returned</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * arena stay around potentially over 2+ sessions and can be shared via any of them (as long as they apply to</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * the same Client_app).  Because of this more-than-session lifetime, the app_shm()-returned arenas are actually tracked</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * in the parent shm::classic::Session_server; it uses one of the Session_server_impl customization points to</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * create the per-Client_app arena as needed at just the right moment during the log-in process; then</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * the shm::classic::Server_session_impl saves that pointer for quick return via `this-&gt;app_shm()`.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * The same arena can also be accessed from the central store via shm::classic::Session_server::app_shm()</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * (which takes a `const Client_app&amp;` and looks it up in an internal map).</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> *</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * Other than that, per-app-scope arenas are created and remembered similarly to per-session-scope ones:</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * create (centrally across server-sessions, on-demand) in `CREATE_ONLY` mode; retain (in each relevant</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * server-session) a pointer for return via `this-&gt;app_shm()`.  See shm::classic::Server_session_impl doc header</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> * and code inside shm::classic::Server_session_impl::async_accept_log_in().</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> *</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * So then to recap:</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> *   - Server: Open handle for session_shm() (create-only mode) and for app_shm() (same), just</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *     before send of log-in response, for each log-in.  app_shm() is stored centrally in originating</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *     shm::classic::Session_server.  Insertion point: *during* vanilla opening procedure.</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *     - Use Server_session_impl::async_accept_log_in()`&#39;s `pre_rsp_setup_func()` arg for this purpose; in turn</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *       inside the body supplied for that guy shm::classic::Session_server  uses the Session_server_impl ctor&#39;s</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *       `per_app_setup_func()` arg (customization point) for the centrally-performed app_shm() arena generation</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *       on-demand.</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> *   - Client: Open handle for session_shm() and app_shm() (open-only mode for each), just after fully completing</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *     the vanilla entry to PEER state (past log-in response receipt).</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *     - shm::classic::Client_session just wraps `session::Client_session_impl::async_connect()` by tacking on</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *       the pool-openings (which are synchronous) onto its user-supplied on-done handler.  Mechanically: Details left</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *       to shm::classic::Client_session docs.</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * In `*this`, mechanically: the true implementation of the needed setup and accessors (explained above) is</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * split between shm::classic::Session_mv (common with `Client_session_impl`) and</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * shm::classic::Server_session_impl, with the vanilla core in super-class session::Server_session_impl.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * There&#39;s an app-scope snippet in shm::classic::Session_server.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> * That&#39;s the key; then session::Server_session_mv adds movability around session::Server_session_impl; and lastly</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * this class sub-classes *that* (by way of `Session_mv`) and completes the puzzle by pImpl-forwarding to the</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * added (SHM-focused) API.  (session::Server_session_mv only pImpl-forwards to the vanilla API.)</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> *</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * The last and most boring piece of the puzzle are the pImpl-lite wrappers around the SHM-specific API</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * that shm::classic::Server_session adds to super-class Server_session_mv: `session_shm()` and so on.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> * Because this API is exactly identical for both shm::classic::Server_session and shm::classic::Client_session,</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * to avoid torturous copy/pasting these wrappers are collected in shm::classic::Session_mv which we sub-class.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * So the `public` API is distributed as follows from bottom to top:</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> *   - shm::classic::Server_session</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> *     =&gt; shm::classic::Session_mv =&gt; session::Server_session_mv =&gt; session::Session_mv</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> *     =&gt; shm::classic::Server_session_impl</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> *   - shm::classic::Client_session</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> *     == shm::classic::Session_mv =&gt; session::Client_session_mv =&gt; session::Session_mv</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> *     =&gt; shm::classic::Client_session_impl</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> *     - The bottom two in this case are not even inherited but one aliases to the other.  This is because</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> *       there&#39;s nothing added API-wise on the client side.  On the server side, as you see below, an internal-use</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> *       ctor is necessary to add, so we can&#39;t alias and must sub-class.  It&#39;s close to an alias though.</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> *</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * You&#39;ll notice, like, `Base::Base::Base::Impl` and `Base::Base::Base::Impl()` in certain code below;</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> * that&#39;s navigating the above hierarchy.</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> *</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * @endinternal</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> * @tparam S_MQ_TYPE_OR_NONE</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> *         Identical to session::Server_session.</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> * @tparam S_TRANSMIT_NATIVE_HANDLES</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> *         Identical to session::Server_session.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> * @tparam Mdt_payload</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> *         Identical to session::Server_session.</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> */</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload&gt;</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html">  216</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html">Server_session</a> :</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span>  <span class="keyword">public</span> <a class="code hl_class" href="classipc_1_1session_1_1shm_1_1classic_1_1Session__mv.html">Session_mv</a>&lt;session::Server_session_mv</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span>                      &lt;Server_session_impl&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;&gt;&gt;</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span>{</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"></span> </div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">  /// Short-hand for our base class.  To the user: note its `public` API is inherited.</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html#a1507bab4b191f908e9c45470fdb8d296">  224</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1shm_1_1classic_1_1Session__mv.html">Base</a> = <a class="code hl_class" href="classipc_1_1session_1_1shm_1_1classic_1_1Session__mv.html">Session_mv</a></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span>                 &lt;<a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">session::Server_session_mv</a></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span>                    &lt;<a class="code hl_class" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session__impl.html">Server_session_impl&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>&gt;&gt;;</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span> </div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"></span> </div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">  /// Inherit default, move ctors.</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classSession__t.html">Base::Base</a>;</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span> </div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span>  <span class="comment">// Constructors.</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment"></span> </div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment">   * For use by internal user Session_server_impl: constructor.  Identical to Server_session_mv ctor.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">   *</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   *        See Server_session_mv ctor.</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   *        See Server_session_mv ctor.</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   * @param master_channel_sock_stm</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   *        See Server_session_mv ctor.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   */</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html#a785acb973864773f6c9b2892af7e9474">Server_session</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span>                          <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">transport::Native_socket_stream</a>&amp;&amp; master_channel_sock_stm);</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>}; <span class="comment">// class Server_session</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span> </div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span> </div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment"></span> </div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"><a class="line" href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a015d4f4169398bbaf8d5e8a63300610f">  255</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_CLSC_SRV_SESSION \</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="preprocessor">  template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno"><a class="line" href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a5bb0b9e8da266c8cab8e53897147d4ca">  258</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_CLSC_SRV_SESSION \</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="preprocessor">  Server_session&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span> </div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a015d4f4169398bbaf8d5e8a63300610f">TEMPLATE_CLSC_SRV_SESSION</a></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html#a785acb973864773f6c9b2892af7e9474">  262</a></span><a class="code hl_typedef" href="namespaceipc_1_1session.html#ab01d5bce0ab2f3435ca9dd88d27609dc">CLASS_CLSC_SRV_SESSION::Server_session</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref_arg,</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span>                                       <a class="code hl_class" href="classipc_1_1transport_1_1Native__socket__stream.html">transport::Native_socket_stream</a>&amp;&amp; master_channel_sock_stm)</div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span>{</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span>  Base::Base::Base::impl() = boost::movelib::make_unique&lt;typename Base::Base::Base::Impl&gt;</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span>                               (logger_ptr, srv_app_ref_arg, std::move(master_channel_sock_stm));</div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span>}</div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span> </div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><a class="code hl_define" href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a015d4f4169398bbaf8d5e8a63300610f">TEMPLATE_CLSC_SRV_SESSION</a></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html#a8fc81db9a5adc7b6efc8529b5f1d98d2">  270</a></span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1shm_1_1classic.html#ae28750f5d14a8ec78ea4d5310e212482">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_define" href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a5bb0b9e8da266c8cab8e53897147d4ca">CLASS_CLSC_SRV_SESSION</a>&amp; val)</div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span>{</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span>  <span class="keywordflow">return</span> os &lt;&lt; static_cast&lt;const typename CLASS_CLSC_SRV_SESSION::Base&amp;&gt;(val);</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>}</div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span> </div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="preprocessor">#undef CLASS_CLSC_SRV_SESSION</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="preprocessor">#undef TEMPLATE_CLSC_SRV_SESSION</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span> </div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span>} <span class="comment">// namespace ipc::session::shm::classic</span></div>
<div class="ttc" id="aclassSession__t_html"><div class="ttname"><a href="classSession__t.html">Session_t</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Server__session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Server__session__mv.html">ipc::session::Server_session_mv</a></div><div class="ttdoc">Implements Session concept on the Server_app end: a Session that is emitted in almost-PEER state by l...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2server__session_8hpp_source.html#l00122">server_session.hpp:124</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1classic_1_1Server__session__impl_html"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session__impl.html">ipc::session::shm::classic::Server_session_impl</a></div><div class="ttdoc">Core internally-used implementation of shm::classic::Server_session: it is to the latter what its pub...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2session_2detail_2shm_2classic_2server__session__impl_8hpp_source.html#l00067">server_session_impl.hpp:72</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1classic_1_1Server__session_html"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html">ipc::session::shm::classic::Server_session</a></div><div class="ttdoc">Identical to session::Server_session in every way, except that it makes available two SHM arenas,...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp_source.html#l00216">server_session.hpp:219</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1classic_1_1Server__session_html_a785acb973864773f6c9b2892af7e9474"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1classic_1_1Server__session.html#a785acb973864773f6c9b2892af7e9474">ipc::session::shm::classic::Server_session::Server_session</a></div><div class="ttdeci">Server_session(flow::log::Logger *logger_ptr, const Server_app &amp;srv_app_ref, transport::Native_socket_stream &amp;&amp;master_channel_sock_stm)</div><div class="ttdoc">For use by internal user Session_server_impl: constructor.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp_source.html#l00262">server_session.hpp:262</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1shm_1_1classic_1_1Session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1shm_1_1classic_1_1Session__mv.html">ipc::session::shm::classic::Session_mv</a></div><div class="ttdoc">Implements the SHM-related API common to shm::classic::Server_session and shm::classic::Client_sessio...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2session_8hpp_source.html#l00042">session.hpp:44</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream_html"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream.html">ipc::transport::Native_socket_stream</a></div><div class="ttdoc">Implements both Native_handle_sender and Native_handle_receiver concepts by using a stream-oriented U...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream_8hpp_source.html#l00270">native_socket_stream.hpp:271</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2server__session_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2server__session_8hpp.html">server_session.hpp</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2session_2detail_2shm_2classic_2server__session__impl_8hpp_html"><div class="ttname"><a href="ipc__shm_2src_2ipc_2session_2detail_2shm_2classic_2server__session__impl_8hpp.html">server_session_impl.hpp</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp_html_a015d4f4169398bbaf8d5e8a63300610f"><div class="ttname"><a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a015d4f4169398bbaf8d5e8a63300610f">TEMPLATE_CLSC_SRV_SESSION</a></div><div class="ttdeci">#define TEMPLATE_CLSC_SRV_SESSION</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp_source.html#l00255">server_session.hpp:255</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp_html_a5bb0b9e8da266c8cab8e53897147d4ca"><div class="ttname"><a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp.html#a5bb0b9e8da266c8cab8e53897147d4ca">CLASS_CLSC_SRV_SESSION</a></div><div class="ttdeci">#define CLASS_CLSC_SRV_SESSION</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2server__session_8hpp_source.html#l00258">server_session.hpp:258</a></div></div>
<div class="ttc" id="aipc__shm_2src_2ipc_2session_2shm_2classic_2session_8hpp_html"><div class="ttname"><a href="ipc__shm_2src_2ipc_2session_2shm_2classic_2session_8hpp.html">session.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1shm_1_1classic_html"><div class="ttname"><a href="namespaceipc_1_1session_1_1shm_1_1classic.html">ipc::session::shm::classic</a></div><div class="ttdoc">Support for SHM-backed ipc::session sessions and session-servers with the SHM-classic (ipc::shm::clas...</div><div class="ttdef"><b>Definition:</b> <a href="session_2detail_2shm_2classic_2classic__fwd_8hpp_source.html#l00023">classic_fwd.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1shm_1_1classic_html_ae28750f5d14a8ec78ea4d5310e212482"><div class="ttname"><a href="namespaceipc_1_1session_1_1shm_1_1classic.html#ae28750f5d14a8ec78ea4d5310e212482">ipc::session::shm::classic::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Session_impl&lt; Session_impl_t &gt; &amp;val)</div><div class="ttdoc">Prints string representation of the given Session_impl to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="src_2ipc_2session_2detail_2shm_2classic_2session__impl_8hpp_source.html#l00412">session_impl.hpp:412</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_ab01d5bce0ab2f3435ca9dd88d27609dc"><div class="ttname"><a href="namespaceipc_1_1session.html#ab01d5bce0ab2f3435ca9dd88d27609dc">ipc::session::Server_session</a></div><div class="ttdeci">Server_session_mv&lt; Server_session_impl&lt; S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload &gt; &gt; Server_session</div><div class="ttdoc">A vanilla Server_session with no optional capabilities.</div><div class="ttdef"><b>Definition:</b> <a href="session__fwd_8hpp_source.html#l00288">session_fwd.hpp:289</a></div></div>
<div class="ttc" id="asession_2shm_2classic_2classic_8hpp_html"><div class="ttname"><a href="session_2shm_2classic_2classic_8hpp.html">classic.hpp</a></div></div>
<div class="ttc" id="ashm_2classic_2classic_8hpp_html"><div class="ttname"><a href="shm_2classic_2classic_8hpp.html">classic.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
